-
-
Notifications
You must be signed in to change notification settings - Fork 694
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Amend version policy docs #6541
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for plone-components canceled.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to remove the copy of this file from the documentation repo, and refer to this include instead, in a separate PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we do that, from another repo?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Example. Adjust relative paths as needed.
In Volto docs.
```{include} ../_inc/_install-operating-system.md
```
In documentation.
```{include} ../../volto/_inc/_install-operating-system.md
```
IOW, when you use the include in Volto, then you can refer to it in documentation, after it gets merged in a PR, of course. You cannot go the reverse direction.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. Removed the local inc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's not what I meant. Please read my original statement. The separate PR would be in Documentation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
but the original is in docs already.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to remove the copy of this file from the documentation repo
The docs in Volto have no idea that plone/documentation
exists with regard to includes. Please restore the file /_inc/_install-operating-system.md
here, restore the include
directive, and we will delete the original from plone/documentation
.
You can verify this by trying to build docs locally.
Co-authored-by: Steve Piercy <[email protected]>
Any new feature will be merged into the `main` branch, and only backported to and released in older versions, if the Volto Team approves it. | ||
|
||
`17.x.x` | ||
: `17.x.x` is no longer supported and became legacy when Volto 18 was released. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if we should say something more for 17.x.x
? For example, let's say I have a project with Plone 6.0 and Volto 17. What should I do? Should I upgrade both Plone to 6.1 and Volto to 18? If so, then we need to also link directly to each upgrade guide.
: `17.x.x` is no longer supported and became legacy when Volto 18 was released. | |
: `17.x.x` is no longer supported and became legacy when Volto 18 was released. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not mandatory to upgrade. It can get some updates, if people still care for it, and the Volto Team approve them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sneridagh Steve's right, if we're saying it's no longer supported, we need to give some advice on how to move forward.
It's possible to upgrade to Volto 18 (i.e. by generating a new cookieplone project and moving your custom code over) without updating the backend to Plone 6.1.
Semantic UI development and maintenance has sputtered since 2018. | ||
The Volto Team made the decision to move forward in a sustainable direction. | ||
Plone 7 will use a different theming approach, based on the [`@plone/components`](https://www.npmjs.com/package/@plone/components)—which in turn is based on [React Aria Components](https://react-spectrum.adobe.com/react-aria/components.html)—and [`@plone/theming`](https://github.com/plone/volto/tree/main/packages/theming) packages. | ||
Using Semantic UI theming for your project or add-on is deprecated from Volto 18 onward, and will be removed in Plone 7. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As a side note, after seeing all the added admonitions in theming docs regarding Semantic UI, where would I look now for theming docs for the new way of theming? We should include that in the admonition, too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nowhere to look yet. We should start sending the message: "Whatever you use for theming your site, but SemanticUI, is fine. You can continue using it if you want, but core will abandon it in Plone 7."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I completed the info on 17.x.x
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's not what I meant. Please read my original statement. The separate PR would be in Documentation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's rename it to _semantic-ui-deprecation.md
because there is a space in its official brand name.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
Co-authored-by: Steve Piercy <[email protected]>
: `17.x.x` is no longer supported and became legacy when Volto 18 was released. | ||
It won't receive any bug fixes nor security updates. | ||
It is recommended that you update to 18.x.x. | ||
If you need a bug fix or security update for this version, please submit a pull request, and the Volto Team will review it to determine whether it's suitable to merge. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems to contradict line 41.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm adding a "legacy" entry at the top of the document to clarify it.
@@ -0,0 +1,6 @@ | |||
```{deprecated} Volto 18 | |||
Semantic UI development and maintenance has sputtered since 2018. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Semantic UI development and maintenance has sputtered since 2018. | |
Semantic UI development and maintenance has been inconsistent since 2018. |
```{deprecated} Volto 18.0.0 | ||
`@plone/volto-generator` was deprecated in Volto 18.0.0. | ||
It is not maintained, and you should not use it. | ||
For new projects, use [Cookieplone](https://github.com/plone/cookieplone) instead. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should link to https://6.docs.plone.org/install/create-project-cookieplone.html here, not the Cookieplone repository.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The whole sentence needs a rewrite. This syntax should work via Intersphinx for both here and plone/documentation
.
For new projects, use [Cookieplone](https://github.com/plone/cookieplone) instead. | |
For new projects, follow {doc}`plone:install/create-project-cookieplone` instead. |
=>
For new projects, follow Install Plone with Cookieplone instead.
``` | ||
|
||
`@plone/volto-generator` is a tool that generates a Volto project. | ||
The following table describes the compatibility between versions of `@plone/volto-generator` and Volto. | ||
|
||
| Generator version | Volto version | | ||
|-------------------|---------------| |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The next line makes it sound like it's still supported for Volto 18, we need to change that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does it work in 18? I assumed that if something works, then that means it's supported.
Also if something works, it can also be deprecated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, we started to update it for Volto 18 but then realized we needed to create Cookieplone instead, because the structure was too different.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since it doesn't work in 18, then why do we even have it in 18? https://github.com/plone/volto/tree/main/packages/generator-volto
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"It does work" but it's true that maybe we should not advertise it, it could be confusing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, I just tried it, and it didn't work for me. But it could be that the Training I followed has incorrect information.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@stevepiercy there's still an acceptance test for it in place. So it should still work for 18. For project, the add-on template is not being tested. What did you do? That training could be outdated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I followed the exact instructions published in that training, pretending to be a learner.
Co-authored-by: David Glick <[email protected]> Co-authored-by: Steve Piercy <[email protected]>
…larify what legacy means.
First draft
📚 Documentation preview 📚: https://volto--6541.org.readthedocs.build/